/*
 * Copyright 2013 Sigurd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.digiway.rapidbreeze.client.model.config;

import de.digiway.rapidbreeze.shared.rest.config.ServerConfigurationResourceEntry;
import java.util.List;

/**
 * Interface for retrieving and setting String based configurations.
 *
 * @author Sigurd
 */
public interface ServerConfigurationResourceRepository {

    /**
     * Sets a configuration value of the given key. If the key does not exist,
     * it will be created. Otherwise it will be updated.
     *
     * @param key
     * @param value
     */
    public void setConfiguration(String key, Object value);

    /**
     * Retrieves the configuration value of the given key.
     *
     * @param key
     * @return
     */
    public <T> T getConfiguration(String key);

    /**
     * Checks if there is a configuration value for the given key
     *
     * @param key
     * @return
     */
    public boolean hasConfiguration(String key);

    /**
     * Returns a {@linkplain List} of all
     * {@linkplain ServerConfigurationResourceEntry} elements in the
     * configuration.
     *
     * @return
     */
    public List<ServerConfigurationResourceEntry> getEntries();
}
